/*
 * Package il.ac.biu.cs.grossmm.impl.server
 * File Service.java
 * 
 * This is a part of presence service framework API. 
 * See javadoc for more information.
 *  
 * Copyright (C) 2006 Grossmann Mark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */

package il.ac.biu.cs.grossmm.api.server;

import il.ac.biu.cs.grossmm.api.server.ServiceManager;

public interface Service {

	/**
	 * Starts the service. Iff service cannot be started, an exception should
	 * be thrown. 
	 * 
	 * @throws Exception thrown when service cannot start
	 */
	public void start(ServiceManager serviceManager) throws Exception;
	
	/**
	 * Stops the service. If <tt>exception</tt> is null then service is stopped
	 * because it is no longer needed (normal termination), otherwise it is 
	 * stopped because it there is an exceptional situation which prevents 
	 * this service to function properly (abnormal termination).
	 *
	 */
	public void stop(Exception exception);
	
	/**
	 * Called by service manager when one of services hold in a started state
	 * by this service terminated due to an exceptional condition.
	 * <p>
	 * If this method terminates by thrwoing an exception, then the service is 
	 * stopped and discaded
	 * 
	 * 
	 * @param serviceHint the terminated service hint 
	 * @param e the exception which describes the exceptional condition
	 * @throws Exception
	 */
	public void terminated(Object serviceHint, Exception e) throws Exception;
}
